Skip to content

Enable release notes checks to post comment with instructions#432

Merged
nrichers merged 2 commits intomainfrom
nrichers-patch-2
Oct 8, 2025
Merged

Enable release notes checks to post comment with instructions#432
nrichers merged 2 commits intomainfrom
nrichers-patch-2

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Oct 8, 2025

Pull Request Description

What and why?

It looks like there might be another issue with the release notes workflow in that it needs better permissions to output a comment with instructions:

Capto_ 2025-10-08_04-06-02_pm2

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@nrichers nrichers added the internal Not to be externalized in the release notes label Oct 8, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2025

PR Summary

This PR improves the checks around release notes in pull requests by updating the error message in the release notes checking script. The new message clarifies that, aside from the internal label (which does not require release notes), all other pull requests must include a descriptive release notes section.

Additionally, the PR modifies the GitHub Action workflow for release notes checks by changing the permission for pull-requests from read to write. This adjustment likely enables the workflow to create issue comments or perform other write operations on pull request objects, ensuring that the updated message can be correctly posted as a comment on the PR.

Test Suggestions

  • Verify that a pull request with the required non-internal label but missing a valid release notes description triggers the new error message.
  • Test that a pull request labeled internal bypasses the requirement for a release notes description.
  • Check that the GitHub Action workflow successfully posts an issue comment when the release notes check fails.
  • Ensure that the workflow's elevated pull-requests permission does not introduce any unintended side effects by validating the scope of its access.

@nrichers nrichers merged commit c11f85d into main Oct 8, 2025
6 checks passed
@nrichers nrichers deleted the nrichers-patch-2 branch October 8, 2025 23:38
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants